[Library] Update dependencies graph and typo about libraries links description #94
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…scription In this commit, I've updated the dependency graph to the Bitcoin 29.0 (The actual maintained version for bitcoin Core). This graph show the entire dependencies links between various library of the code base structure.
heyolaniran
changed the title
Added the missing id tag to link the documentation to the HTML file generated by jekyll on build
Collaborator
|
Hello, thanks for the PR! I think you will still need something like: diff --git a/library-structure.adoc b/library-structure.adoc
index 32d0890..79afab0 100644
--- a/library-structure.adoc
+++ b/library-structure.adoc
@@ -12,12 +12,8 @@ Bitcoin Core has a https://github.com/bitcoin/bitcoin/blob/master/doc/design/lib
[id=library-dependency-graph]
.Bitcoin library dependency graph
[mermaid, target=bitcoion-lib-dependencies]
-
-```mermaid
-
-%%{ init : { "flowchart" : { "curve" : "basis" }}}%%
-
-graph TD;
+....
+flowchart TB
bitcoin-cli[bitcoin-cli]-->libbitcoin_cli;
@@ -64,7 +60,8 @@ libbitcoin_wallet_tool-->libbitcoin_util;
classDef bold stroke-width:2px, font-weight:bold, font-size: smaller;
class bitcoin-qt,bitcoind,bitcoin-cli,bitcoin-wallet bold
-```
+....
+
**Dependency graph**. Arrows show linker symbol dependencies. `libbitcoin_crypto` depends on nothing. `libbitcoin_util` is depended on by everything. `libbitcoin_kernel` depends only on consensus, crypto, and util.
It follows that API changes to the libraries which are internally-facing can be done slightly easier than for libraries with externally-facing APIs, for which more care for compatibility must be taken.To get this to render correctly using jekyll and just-the-docs. I am going to merge a PR to try and make local development easier, as it's a bit of a pain (IMO) at the moment. I have tested your PR out using it to find it doesn't render correctly. |
Contributor
Author
|
Thank you, I'll try with your new local development commit and try to fix the render. |
Collaborator
|
It should work now if you rebase on master |
Contributor
Author
|
Spotted it, I've just get it done. 🥇 @willcl-ark and submitted it in the latest commit of this PR. |
Collaborator
|
Closed via #98 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello @willcl-ark In this pull request, I've updated the dependency graph to the Bitcoin 29.0 (The actual maintained version for bitcoin Core). This graph show the entire dependencies links between various libraries of the code base structure.
Thanks for reviewing my proposal.